<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>rfdc: xrfdc_read_write_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">rfdc
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xrfdc__read__write__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xrfdc_read_write_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This example uses multiple driver "set" APIs to configure the targeted AMS block. </p>
<p>Subsequently it uses "get" APIs to read back the configurations to ensure that the desired configurations are applied.</p>
<p>For DAC it sets the following configurations: MixerSettings, QMCSettings, Write Fabricrate, Decoder mode, Output Current and Coarse Delay.</p>
<p>For ADC it sets the following configurations: MixerSettings, QMCSettings, Read Fabricrate and Threshold Settings. This example shows how to change the configurations for ADC and DAC using driver functions.</p>
<p>NOTE: The purpose of the example is to show how to use the driver APIs. For real user scenarios this example will not be relevant.</p>
<p>For zcu111 board users are expected to define XPS_BOARD_ZCU111 macro while compiling this example.</p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.0   sk     05/15/17 First release
1.1   sk     08/09/17 Modified the example to support both Linux and
                      Baremetal.
      sk     08/23/17 Add Nyquist Zone test case.
      sk     09/25/17 Add GetOutput Current test case.
2.4   sk     12/11/17 Add test case for DDC and DUC.
3.2   sk     03/01/18 Add test case for Multiband.
4.0   sd     04/28/18 Add Clock configuration support for ZCU111.
      sd     05/15/18 Updated Clock configuration for lmk.
5.0   sk     07/20/18 Update mixer settings test cases to consider MixerType.
      sk     08/03/18 For baremetal, add metal device structure for rfdc
                      device and register the device to libmetal generic bus.
      mus    08/18/18 Updated to remove xparameters.h dependency for linux
                      platform.
      sk     09/07/18 Modified phasecorrection factor as per  QMC Phase
                      correction factor range in driver
5.1   cog    01/29/19 Fixed some comments.
7.0   cog    07/25/19 Updated example for new metal register API.
7.1   cog    07/25/19 Updated example for Gen 3 compatibility.
8.0   cog    04/03/20 Updated example for 48dr compatibility.
8.1   cog    06/29/20 Always register metal device in baremetal.
      cog    07/03/20 The metal_phys parameter is baremetal only.
      cog    08/04/20 Connected Q data for Dual DACs should be block 2.
      cog    08/28/20 Make suitable for the default Petalinux designs
                      for Gen 1/2 devices.
      cog    09/21/20 Fixed case where partial reconfiguration was being
                      implemented.
12.1  cog    07/14/23 Modified for SDT flow
      cog    07/25/23 Remove dead code</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xrfdc__read__write__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function that invokes the polled example in this file.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function that invokes the polled example in this file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XRFDC_SUCCESS if the example has completed successfully.</li>
<li>XRFDC_FAILURE if the example has failed.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
